docs: Reorg and improve user experience #11340
Draft
+12,098
−6,000
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tsteenbe
force-pushed
the
docs-rewrite-diataxis
branch
2 times, most recently
from
0304644 to
e51365a
Compare
Reorganize and improve documentation to provide a better getting started and documentation navigation user experience. This pull requests includes: - Adoption of the Diátaxis framework which prioritizes user needs and organizes documentation accordingly. This approach ensures users can easily find the information they need while providing authors with clear guidance on improving documentation for a better user experience. - A new tutorial on how to use ORT - Several how-to guides have been added explaining how to accomplish specific tasks with ORT - Introduces a new explanation section to provide background and context e.g. the 'why' things are so (design decisions, historical reasons, technical constraints) Co-authored-by: Jonatan Männchen <[email protected]> Signed-off-by: Jonatan Männchen <[email protected]> Signed-off-by: Thomas Steenbergen <[email protected]>
tsteenbe
force-pushed
the
docs-rewrite-diataxis
branch
from
e51365a to
5db6dc5
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11340 +/- ##
=========================================
Coverage 57.77% 57.77%
Complexity 1714 1714
=========================================
Files 346 346
Lines 12900 12900
Branches 1235 1235
=========================================
Hits 7453 7453
Misses 5001 5001
Partials 446 446
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tsteenbe
force-pushed
the
docs-rewrite-diataxis
branch
9 times, most recently
from
244d421 to
8333b99
Compare
tsteenbe
force-pushed
the
docs-rewrite-diataxis
branch
14 times, most recently
from
c9f317d to
1b41302
Compare
This reverts commit ff6a5be. The max-one-sentence-per-line rule fragments explanatory content into choppy, disconnected lines that harm readability. Technical documentation often requires flowing prose to explain complex concepts coherently. Removing this rule allows authors to write natural paragraphs that maintain context and guide readers through detailed explanations Signed-off-by: Thomas Steenbergen <[email protected]>
tsteenbe
force-pushed
the
docs-rewrite-diataxis
branch
from
1b41302 to
92c757d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reorganize and improve documentation to provide a better getting started and documentation navigation user experience.
This pull requests includes: